esc to dismiss
rechercher Rechercher
x

Générer et compléter la DOC OpenAPI

Une fois votre API créée, la documentation OpenAPI sera générée de façon automatique.
La génération utilise les entrées / sorties des smartflows, cependant, il restera quelques sections à remplir pour une documentation complète.

Compléter la documentation

On retrouve dans l'inspecteur de smartflow le bouton Open API qui permet de compléter la documentation OpenAPI concernant la description et les réponses pour le smartflow concerné.

Example

Voici un exemple d'une documentation complétée pour un smartflow de création de Voiture.

Générer la documentation

Pour générer la documentation, il suffit d'aller à l'adresse
https://nom-de-domaine/studio/doc

Example

Voici un exemple d'une documentation générée pour un smartflow de création de Voiture.

x